<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="null" lang="null">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>ContextSupport xref</title>
<link type="text/css" rel="stylesheet" href="../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../apidocs/org/jaxen/ContextSupport.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> org.jaxen;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> $Id: ContextSupport.java 1157 2006-06-03 20:07:37Z elharo $</em>
<a name="5" href="#5">5</a>   
<a name="6" href="#6">6</a>   <em class="comment"> Copyright 2003 The Werken Company. All Rights Reserved.</em>
<a name="7" href="#7">7</a>   <em class="comment"> </em>
<a name="8" href="#8">8</a>   <em class="comment">Redistribution and use in source and binary forms, with or without</em>
<a name="9" href="#9">9</a>   <em class="comment">modification, are permitted provided that the following conditions are</em>
<a name="10" href="#10">10</a>  <em class="comment">met:</em>
<a name="11" href="#11">11</a>  
<a name="12" href="#12">12</a>  <em class="comment">  * Redistributions of source code must retain the above copyright</em>
<a name="13" href="#13">13</a>  <em class="comment">    notice, this list of conditions and the following disclaimer.</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <em class="comment">  * Redistributions in binary form must reproduce the above copyright</em>
<a name="16" href="#16">16</a>  <em class="comment">    notice, this list of conditions and the following disclaimer in the</em>
<a name="17" href="#17">17</a>  <em class="comment">    documentation and/or other materials provided with the distribution.</em>
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <em class="comment">  * Neither the name of the Jaxen Project nor the names of its</em>
<a name="20" href="#20">20</a>  <em class="comment">    contributors may be used to endorse or promote products derived </em>
<a name="21" href="#21">21</a>  <em class="comment">    from this software without specific prior written permission.</em>
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <em class="comment">THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS</em>
<a name="24" href="#24">24</a>  <em class="comment">IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED</em>
<a name="25" href="#25">25</a>  <em class="comment">TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</em>
<a name="26" href="#26">26</a>  <em class="comment">PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER</em>
<a name="27" href="#27">27</a>  <em class="comment">OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</em>
<a name="28" href="#28">28</a>  <em class="comment">EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</em>
<a name="29" href="#29">29</a>  <em class="comment">PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</em>
<a name="30" href="#30">30</a>  <em class="comment">PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</em>
<a name="31" href="#31">31</a>  <em class="comment">LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</em>
<a name="32" href="#32">32</a>  <em class="comment">NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</em>
<a name="33" href="#33">33</a>  <em class="comment">SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</em>
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>  <em class="comment"> */</em>
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <strong>import</strong> java.io.Serializable;
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>  <em>/**</em><em> Supporting context information for resolving</em>
<a name="40" href="#40">40</a>  <em> *  namespace prefixes, functions, and variables.</em>
<a name="41" href="#41">41</a>  <em> * </em>
<a name="42" href="#42">42</a>  <em> *  &lt;p></em>
<a name="43" href="#43">43</a>  <em> *  &lt;strong>NOTE:&lt;/strong> This class is not typically used directly,</em>
<a name="44" href="#44">44</a>  <em> *  but is exposed for writers of implementation-specific</em>
<a name="45" href="#45">45</a>  <em> *  XPath packages.</em>
<a name="46" href="#46">46</a>  <em> *  &lt;/p></em>
<a name="47" href="#47">47</a>  <em> *</em>
<a name="48" href="#48">48</a>  <em> *  @see org.jaxen.dom4j.Dom4jXPath XPath for dom4j</em>
<a name="49" href="#49">49</a>  <em> *  @see org.jaxen.jdom.JDOMXPath   XPath for JDOM</em>
<a name="50" href="#50">50</a>  <em> *  @see org.jaxen.dom.DOMXPath     XPath for W3C DOM</em>
<a name="51" href="#51">51</a>  <em> *</em>
<a name="52" href="#52">52</a>  <em> *  @author &lt;a href="<a href="mailto:bob@eng.werken.com" target="alexandria_uri">mailto:bob@eng.werken.com</a>">bob mcwhirter&lt;/a></em>
<a name="53" href="#53">53</a>  <em> *</em>
<a name="54" href="#54">54</a>  <em> *  @version $Id: ContextSupport.java 1157 2006-06-03 20:07:37Z elharo $</em>
<a name="55" href="#55">55</a>  <em> */</em>
<a name="56" href="#56">56</a>  <strong>public</strong> <strong>class</strong> <a href="../../org/jaxen/ContextSupport.html">ContextSupport</a> implements Serializable {
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>      <em>/**</em>
<a name="59" href="#59">59</a>  <em>     * </em>
<a name="60" href="#60">60</a>  <em>     */</em>
<a name="61" href="#61">61</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>long</strong> serialVersionUID = 4494082174713652559L;
<a name="62" href="#62">62</a>  
<a name="63" href="#63">63</a>      <em>/**</em><em> <a href="../../org/jaxen/Function.html">Function</a> context. */</em>
<a name="64" href="#64">64</a>      <strong>private</strong> <strong>transient</strong> <a href="../../org/jaxen/FunctionContext.html">FunctionContext</a> functionContext;
<a name="65" href="#65">65</a>      
<a name="66" href="#66">66</a>      <em>/**</em><em> Namespace context. */</em>
<a name="67" href="#67">67</a>      <strong>private</strong> <a href="../../org/jaxen/NamespaceContext.html">NamespaceContext</a> namespaceContext;
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>      <em>/**</em><em> Variable context. */</em>
<a name="70" href="#70">70</a>      <strong>private</strong> <a href="../../org/jaxen/VariableContext.html">VariableContext</a> variableContext;
<a name="71" href="#71">71</a>      
<a name="72" href="#72">72</a>      <em>/**</em><em> Model navigator. */</em>
<a name="73" href="#73">73</a>      <strong>private</strong> <a href="../../org/jaxen/Navigator.html">Navigator</a> navigator;
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>      <em class="comment">// ----------------------------------------------------------------------</em>
<a name="76" href="#76">76</a>      <em class="comment">//     Constructors</em>
<a name="77" href="#77">77</a>      <em class="comment">// ----------------------------------------------------------------------</em>
<a name="78" href="#78">78</a>      
<a name="79" href="#79">79</a>      <em>/**</em><em> Construct an empty &lt;code>ContextSupport&lt;/code>.</em>
<a name="80" href="#80">80</a>  <em>     */</em>
<a name="81" href="#81">81</a>      <strong>public</strong> <a href="../../org/jaxen/ContextSupport.html">ContextSupport</a>()
<a name="82" href="#82">82</a>      {
<a name="83" href="#83">83</a>          <em class="comment">// intentionally left blank</em>
<a name="84" href="#84">84</a>      }
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>      <em>/**</em><em> Create a new ContextSupport object.</em>
<a name="87" href="#87">87</a>  <em>     *</em>
<a name="88" href="#88">88</a>  <em>     *  @param namespaceContext the NamespaceContext</em>
<a name="89" href="#89">89</a>  <em>     *  @param functionContext the FunctionContext</em>
<a name="90" href="#90">90</a>  <em>     *  @param variableContext the VariableContext</em>
<a name="91" href="#91">91</a>  <em>     *  @param navigator the model navigator</em>
<a name="92" href="#92">92</a>  <em>     */</em>
<a name="93" href="#93">93</a>      <strong>public</strong> <a href="../../org/jaxen/ContextSupport.html">ContextSupport</a>(<a href="../../org/jaxen/NamespaceContext.html">NamespaceContext</a> namespaceContext,
<a name="94" href="#94">94</a>                            <a href="../../org/jaxen/FunctionContext.html">FunctionContext</a> functionContext,
<a name="95" href="#95">95</a>                            <a href="../../org/jaxen/VariableContext.html">VariableContext</a> variableContext,
<a name="96" href="#96">96</a>                            <a href="../../org/jaxen/Navigator.html">Navigator</a> navigator)
<a name="97" href="#97">97</a>      {
<a name="98" href="#98">98</a>          setNamespaceContext( namespaceContext );
<a name="99" href="#99">99</a>          setFunctionContext( functionContext );
<a name="100" href="#100">100</a>         setVariableContext( variableContext );
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>         <strong>this</strong>.navigator = navigator;
<a name="103" href="#103">103</a>     }
<a name="104" href="#104">104</a> 
<a name="105" href="#105">105</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="106" href="#106">106</a>     <em class="comment">//     Instance methods</em>
<a name="107" href="#107">107</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>     <em>/**</em><em> Set the &lt;code>NamespaceContext&lt;/code>.</em>
<a name="110" href="#110">110</a> <em>     *</em>
<a name="111" href="#111">111</a> <em>     *  @param namespaceContext the namespace context</em>
<a name="112" href="#112">112</a> <em>     */</em>
<a name="113" href="#113">113</a>     <strong>public</strong> <strong>void</strong> setNamespaceContext(<a href="../../org/jaxen/NamespaceContext.html">NamespaceContext</a> namespaceContext)
<a name="114" href="#114">114</a>     {
<a name="115" href="#115">115</a>         <strong>this</strong>.namespaceContext = namespaceContext;
<a name="116" href="#116">116</a>     }
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>     <em>/**</em><em> Retrieve the &lt;code>NamespaceContext&lt;/code>.</em>
<a name="119" href="#119">119</a> <em>     *</em>
<a name="120" href="#120">120</a> <em>     *  @return the namespace context</em>
<a name="121" href="#121">121</a> <em>     */</em>
<a name="122" href="#122">122</a>     <strong>public</strong> <a href="../../org/jaxen/NamespaceContext.html">NamespaceContext</a> getNamespaceContext()
<a name="123" href="#123">123</a>     {
<a name="124" href="#124">124</a>         <strong>return</strong> <strong>this</strong>.namespaceContext;
<a name="125" href="#125">125</a>     }
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>     <em>/**</em><em> Set the &lt;code>FunctionContext&lt;/code>.</em>
<a name="128" href="#128">128</a> <em>     *</em>
<a name="129" href="#129">129</a> <em>     *  @param functionContext the function context</em>
<a name="130" href="#130">130</a> <em>     */</em>
<a name="131" href="#131">131</a>     <strong>public</strong> <strong>void</strong> setFunctionContext(<a href="../../org/jaxen/FunctionContext.html">FunctionContext</a> functionContext)
<a name="132" href="#132">132</a>     {
<a name="133" href="#133">133</a>         <strong>this</strong>.functionContext  = functionContext;
<a name="134" href="#134">134</a>     }
<a name="135" href="#135">135</a> 
<a name="136" href="#136">136</a>     <em>/**</em><em> Retrieve the &lt;code>FunctionContext&lt;/code>.</em>
<a name="137" href="#137">137</a> <em>     *</em>
<a name="138" href="#138">138</a> <em>     *  @return the function context</em>
<a name="139" href="#139">139</a> <em>     */</em>
<a name="140" href="#140">140</a>     <strong>public</strong> <a href="../../org/jaxen/FunctionContext.html">FunctionContext</a> getFunctionContext()
<a name="141" href="#141">141</a>     {
<a name="142" href="#142">142</a>         <strong>return</strong> <strong>this</strong>.functionContext;
<a name="143" href="#143">143</a>     }
<a name="144" href="#144">144</a> 
<a name="145" href="#145">145</a>     <em>/**</em><em> Set the &lt;code>VariableContext&lt;/code>.</em>
<a name="146" href="#146">146</a> <em>     *</em>
<a name="147" href="#147">147</a> <em>     *  @param variableContext the variable context</em>
<a name="148" href="#148">148</a> <em>     */</em>
<a name="149" href="#149">149</a>     <strong>public</strong> <strong>void</strong> setVariableContext(<a href="../../org/jaxen/VariableContext.html">VariableContext</a> variableContext)
<a name="150" href="#150">150</a>     {
<a name="151" href="#151">151</a>         <strong>this</strong>.variableContext  = variableContext;
<a name="152" href="#152">152</a>     }
<a name="153" href="#153">153</a> 
<a name="154" href="#154">154</a>     <em>/**</em><em> Retrieve the &lt;code>VariableContext&lt;/code>.</em>
<a name="155" href="#155">155</a> <em>     *</em>
<a name="156" href="#156">156</a> <em>     *  @return the variable context</em>
<a name="157" href="#157">157</a> <em>     */</em>
<a name="158" href="#158">158</a>     <strong>public</strong> <a href="../../org/jaxen/VariableContext.html">VariableContext</a> getVariableContext()
<a name="159" href="#159">159</a>     {
<a name="160" href="#160">160</a>         <strong>return</strong> <strong>this</strong>.variableContext;
<a name="161" href="#161">161</a>     }
<a name="162" href="#162">162</a> 
<a name="163" href="#163">163</a>     <em>/**</em><em> Retrieve the &lt;code>Navigator&lt;/code>.</em>
<a name="164" href="#164">164</a> <em>     *</em>
<a name="165" href="#165">165</a> <em>     *  @return the navigator</em>
<a name="166" href="#166">166</a> <em>     */</em>
<a name="167" href="#167">167</a>     <strong>public</strong> <a href="../../org/jaxen/Navigator.html">Navigator</a> getNavigator()
<a name="168" href="#168">168</a>     {
<a name="169" href="#169">169</a>         <strong>return</strong> <strong>this</strong>.navigator;
<a name="170" href="#170">170</a>     }
<a name="171" href="#171">171</a> 
<a name="172" href="#172">172</a>     <em class="comment">// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - </em>
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a>     <em>/**</em><em> Translate a namespace prefix to its URI.</em>
<a name="175" href="#175">175</a> <em>     *</em>
<a name="176" href="#176">176</a> <em>     *  @param prefix The prefix</em>
<a name="177" href="#177">177</a> <em>     *</em>
<a name="178" href="#178">178</a> <em>     *  @return the namespace URI mapped to the prefix</em>
<a name="179" href="#179">179</a> <em>     */</em>
<a name="180" href="#180">180</a>     <strong>public</strong> String translateNamespacePrefixToUri(String prefix)
<a name="181" href="#181">181</a>     {
<a name="182" href="#182">182</a>         
<a name="183" href="#183">183</a>         <strong>if</strong> (<span class="string">"xml"</span>.equals(prefix)) {
<a name="184" href="#184">184</a>             <strong>return</strong> <span class="string">"http://www.w3.org/XML/1998/namespace"</span>;
<a name="185" href="#185">185</a>         }
<a name="186" href="#186">186</a>         <a href="../../org/jaxen/NamespaceContext.html">NamespaceContext</a> context = getNamespaceContext();
<a name="187" href="#187">187</a> 
<a name="188" href="#188">188</a>         <strong>if</strong> ( context != <strong>null</strong> )
<a name="189" href="#189">189</a>         {
<a name="190" href="#190">190</a>             <strong>return</strong> context.translateNamespacePrefixToUri( prefix );
<a name="191" href="#191">191</a>         }
<a name="192" href="#192">192</a> 
<a name="193" href="#193">193</a>         <strong>return</strong> <strong>null</strong>;
<a name="194" href="#194">194</a>     }
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a>     <em>/**</em><em> Retrieve a variable value.</em>
<a name="197" href="#197">197</a> <em>     *</em>
<a name="198" href="#198">198</a> <em>     *  @param namespaceURI the function namespace URI</em>
<a name="199" href="#199">199</a> <em>     *  @param prefix the function prefix</em>
<a name="200" href="#200">200</a> <em>     *  @param localName the function name</em>
<a name="201" href="#201">201</a> <em>     *</em>
<a name="202" href="#202">202</a> <em>     *  @return the variable value.</em>
<a name="203" href="#203">203</a> <em>     *</em>
<a name="204" href="#204">204</a> <em>     *  @throws UnresolvableException if unable to locate a bound variable.</em>
<a name="205" href="#205">205</a> <em>     */</em>
<a name="206" href="#206">206</a>     <strong>public</strong> Object getVariableValue( String namespaceURI,
<a name="207" href="#207">207</a>                                     String prefix,
<a name="208" href="#208">208</a>                                     String localName )
<a name="209" href="#209">209</a>         throws <a href="../../org/jaxen/UnresolvableException.html">UnresolvableException</a>
<a name="210" href="#210">210</a>     {
<a name="211" href="#211">211</a>         <a href="../../org/jaxen/VariableContext.html">VariableContext</a> context = getVariableContext();
<a name="212" href="#212">212</a> 
<a name="213" href="#213">213</a>         <strong>if</strong> ( context != <strong>null</strong> )
<a name="214" href="#214">214</a>         {
<a name="215" href="#215">215</a>             <strong>return</strong> context.getVariableValue( namespaceURI, prefix, localName );
<a name="216" href="#216">216</a>         }
<a name="217" href="#217">217</a>         <strong>else</strong>
<a name="218" href="#218">218</a>         {
<a name="219" href="#219">219</a>             <strong>throw</strong> <strong>new</strong> <a href="../../org/jaxen/UnresolvableException.html">UnresolvableException</a>( <span class="string">"No variable context installed"</span> );
<a name="220" href="#220">220</a>         }
<a name="221" href="#221">221</a>     }
<a name="222" href="#222">222</a> 
<a name="223" href="#223">223</a>     <em>/**</em><em> Retrieve a &lt;code>Function&lt;/code>.</em>
<a name="224" href="#224">224</a> <em>     *</em>
<a name="225" href="#225">225</a> <em>     *  @param namespaceURI the function namespace URI</em>
<a name="226" href="#226">226</a> <em>     *  @param prefix the function prefix</em>
<a name="227" href="#227">227</a> <em>     *  @param localName the function name</em>
<a name="228" href="#228">228</a> <em>     *</em>
<a name="229" href="#229">229</a> <em>     *  @return the function object</em>
<a name="230" href="#230">230</a> <em>     *</em>
<a name="231" href="#231">231</a> <em>     *  @throws UnresolvableException if unable to locate a bound function</em>
<a name="232" href="#232">232</a> <em>     */</em>
<a name="233" href="#233">233</a>     <strong>public</strong> <a href="../../org/jaxen/Function.html">Function</a> getFunction( String namespaceURI,
<a name="234" href="#234">234</a>                                  String prefix,
<a name="235" href="#235">235</a>                                  String localName )
<a name="236" href="#236">236</a>         throws <a href="../../org/jaxen/UnresolvableException.html">UnresolvableException</a>
<a name="237" href="#237">237</a>     {
<a name="238" href="#238">238</a>         <a href="../../org/jaxen/FunctionContext.html">FunctionContext</a> context = getFunctionContext();
<a name="239" href="#239">239</a> 
<a name="240" href="#240">240</a>         <strong>if</strong> ( context != <strong>null</strong> )
<a name="241" href="#241">241</a>         {
<a name="242" href="#242">242</a>             <strong>return</strong> context.getFunction( namespaceURI, prefix, localName );
<a name="243" href="#243">243</a>         }
<a name="244" href="#244">244</a>         <strong>else</strong>
<a name="245" href="#245">245</a>         {
<a name="246" href="#246">246</a>             <strong>throw</strong> <strong>new</strong> <a href="../../org/jaxen/UnresolvableException.html">UnresolvableException</a>( <span class="string">"No function context installed"</span> );
<a name="247" href="#247">247</a>         }
<a name="248" href="#248">248</a>     }
<a name="249" href="#249">249</a>     
<a name="250" href="#250">250</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

